4.3.4.3 查询组织架构详情-基于外部id
可通过此接口在用户目录查询组织架构详情。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/group/queryByExternalId请求方式：
GET
请求头（Header）
- 请求参数（Query）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@） |
| externalId | 外部id | 是 | string | 待查询组织架构的外部 id 示例：81dc9bdb52d04dc2 |
- 请求示例
基于外部 id 查询：
curl --location --request GET 'https://SDPC-IP:4433/api/v3/group/queryByExternalId?directoryDomain=custom01339&externalId=81dc9bdb52d04dc2' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--header 'Cookie: locale=zh-cn'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| ├─ id | id | string | 示例： 2000dfe1-e4fe-11ee-bee9-fefcfeefe529 |
| ├─ externalId | 外部id | string | 示例： 81dc9bdb52d04dc2 |
| ├─ name | 所属组织架构的名称 | string | 示例： 当前所属组织架构为 /客服体系/专家中心/零信任专家组，则所属组织架构的名称为：c |
| ├─ path | 所属组织架构的路径 | string | 示例： 当前所属组织架构为 /客服体系/专家中心/零信任专家组，则所属组织架构的路径为：/客服体系/专家中心 |
| ├─ description | 描述信息 | string | |
| ├─ isDeleted | 是否外部已删除 | number | 取值范围：0-否1-是 |
| ├─ resourceIdList | 关联应用 id 数组 | string[] | 示例： [ "08975347-e68b-4c15-b4f3-93eb8fbfd101", "47fc233a-c620-4fd1-88e2-290f8918ccdd" ] |
| ├─ resourceGroupIdList | 关联应用分类 id 数组 | string[] | 示例： [ "cb818f04-2271-43ad-b103-0241d92597cc", "86ed36d9-833f-4167-8320-61a03afb09c9" ] |
| ├─ roleIdList | 关联角色 id 数组 | string[] | 示例： [ "1d323967-9bdd-4561-ba44-e556821c2db1", "e54ac72a-6a71-433f-b25f-90e5763977f3" ] |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"id": "2000dfe1-e4fe-11ee-bee9-fefcfeefe529",
"name": "c",
"path": "/客服体系/专家中心",
"externalId": "81dc9bdb52d04dc2",
"description": "grp a desc",
"isDeleted": 0,
"resourceIdList": [
"08975347-e68b-4c15-b4f3-93eb8fbfd101",
"47fc233a-c620-4fd1-88e2-290f8918ccdd"
],
"resourceGroupIdList": [
"cb818f04-2271-43ad-b103-0241d92597cc",
"86ed36d9-833f-4167-8320-61a03afb09c9"
],
"roleIdList": [
"1d323967-9bdd-4561-ba44-e556821c2db1",
"e54ac72a-6a71-433f-b25f-90e5763977f3"
]
},
"msg": "请求成功",
"traceId": "004c0dc61d4a3c24"
}
错误码